.. _CSoundImp Class:

==========================
CSoundImp Class
==========================

.. toctree::
   :maxdepth: 1

* :ref:`Overview<CSoundImp_Overview>`
* :ref:`Quick Reference<CSoundImp_QuickRef>`
* :ref:`Constructors<CSoundImp_Constructors>`
* :ref:`Methods<CSoundImp_Methods>`

----

.. _CSoundImp_Overview:

Overview
---------------

.. note:: The **CSoundImp** class handles sound

The structure used for this class is :ref:`CSoundImp<CSoundImp>`

----

.. _CSoundImp_QuickRef:

Quick Reference
---------------

+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Quick Ref**                                                                                                                                                                                    |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CSoundImp\:\:CSoundImp**\(:ref:`CSound<CSound>`\* parent)                                                                                                                                 |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CSoundImp\:\:CSoundImp**\(:ref:`CSound<CSound>`\* parent, :ref:`CResRef<CResRef>` cNewResRef, int nNewRange, int nNewChannel, int nNewLooping, int nNewPriority, int bNewPositionedSound) |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual void **CSoundImp\:\:~CSoundImp**\()                                                                                                                                                      |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| bool **CSoundImp\:\:CalcVariableVolume**\()                                                                                                                                                      |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| bool **CSoundImp\:\:CopyData**\()                                                                                                                                                                |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| bool **CSoundImp\:\:Create2DBuffer**\()                                                                                                                                                          |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| bool **CSoundImp\:\:Create3DBuffer**\()                                                                                                                                                          |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| bool **CSoundImp\:\:CreateBuffer**\()                                                                                                                                                            |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| int **CSoundImp\:\:ExclusivePlay**\(int bReplay)                                                                                                                                                 |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| bool **CSoundImp\:\:ExclusiveStop**\()                                                                                                                                                           |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| unsigned long **CSoundImp\:\:GetPlayTime**\()                                                                                                                                                    |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| int **CSoundImp\:\:IsSoundPlaying**\(unsigned char bInSoundUpdate)                                                                                                                               |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| int **CSoundImp\:\:Play**\(int bReplay)                                                                                                                                                          |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| int **CSoundImp\:\:Play**\(int nNewXCoordinate, int nNewYCoordinate, int nNewZCoordinate, int bReplay)                                                                                           |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| int **CSoundImp\:\:PlayWaiting**\()                                                                                                                                                              |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CSoundImp\:\:ReleaseSound**\()                                                                                                                                                            |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| int **CSoundImp\:\:ResetVolume**\()                                                                                                                                                              |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| int **CSoundImp\:\:SetChannel**\(int nNewChannel, unsigned int nArea)                                                                                                                            |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CSoundImp\:\:SetCoordinates**\(int nNewXCoordinate, int nNewYCoordinate, int nNewZCoordinate)                                                                                             |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| int **CSoundImp\:\:SetVolume**\(long nNewVolume)                                                                                                                                                 |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| int **CSoundImp\:\:Stop**\()                                                                                                                                                                     |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+


----

.. _CSoundImp_Constructors:

Constructors
---------------

+-----------------------------------------------------+------------------------------------------------------+
| **Name**                                            | **Description**                                      |
+-----------------------------------------------------+------------------------------------------------------+
| :ref:`CSoundImp\:\:CSoundImp<CSoundImpCSoundImp>`   | Constructs a ``CSoundImp`` object                    |
+-----------------------------------------------------+------------------------------------------------------+
| :ref:`CSoundImp\:\:CSoundImp<CSoundImp~CSoundImp>`  | Destroys a ``CSoundImp`` object                      |
+-----------------------------------------------------+------------------------------------------------------+

.. _CSoundImpCSoundImp:

CSoundImp\:\:CSoundImp
^^^^^^^^^^^^^^^^^^^^^^^^^

Constructs a ``CSoundImp`` object

::

   void CSoundImp::CSoundImp(CSound* parent);

**Parameters**

* :ref:`CSound<CSound>`\* *parent* - 

**Remarks**

Constructs a ``CSoundImp`` object


----

CSoundImp\:\:CSoundImp
^^^^^^^^^^^^^^^^^^^^^^^^^

Constructs a ``CSoundImp`` object

::

   void CSoundImp::CSoundImp(
      CSound* parent, 
	  CResRef cNewResRef, 
	  int nNewRange, 
	  int nNewChannel, 
	  int nNewLooping, 
	  int nNewPriority, 
	  int bNewPositionedSound);

**Parameters**

* :ref:`CSound<CSound>`\* *parent* - 
* :ref:`CResRef<CResRef>` *cNewResRef* - 
* ``int`` *nNewRange* - 
* ``int`` *nNewChannel* - 
* ``int`` *nNewLooping* - 
* ``int`` *nNewPriority* - 
* ``int`` *bNewPositionedSound* - 

**Remarks**

Constructs a ``CSoundImp`` object


----

.. _CSoundImp~CSoundImp:

CSoundImp\:\:~CSoundImp
^^^^^^^^^^^^^^^^^^^^^^^^^

Destroys the ``CSoundImp`` object

::

   virtual void CSoundImp::~CSoundImp();

**Remarks**

Destroys the ``CSoundImp`` object


----

.. _CSoundImp_Methods:

Methods
---------------

+---------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| **Name**                                                            | **Description**                                                                         |
+---------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CSoundImp\:\:CalcVariableVolume<CSoundImpCalcVariableVolume>` |                                                                                         |
+---------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CSoundImp\:\:CopyData<CSoundImpCopyData>`                     |                                                                                         |
+---------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CSoundImp\:\:Create2DBuffer<CSoundImpCreate2DBuffer>`         |                                                                                         |
+---------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CSoundImp\:\:Create3DBuffer<CSoundImpCreate3DBuffer>`         |                                                                                         |
+---------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CSoundImp\:\:CreateBuffer<CSoundImpCreateBuffer>`             |                                                                                         |
+---------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CSoundImp\:\:ExclusivePlay<CSoundImpExclusivePlay>`           |                                                                                         |
+---------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CSoundImp\:\:ExclusiveStop<CSoundImpExclusiveStop>`           |                                                                                         |
+---------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CSoundImp\:\:GetPlayTime<CSoundImpGetPlayTime>`               |                                                                                         |
+---------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CSoundImp\:\:IsSoundPlaying<CSoundImpIsSoundPlaying>`         |                                                                                         |
+---------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CSoundImp\:\:Play<CSoundImpPlay>`                             |                                                                                         |
+---------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CSoundImp\:\:PlayWaiting<CSoundImpPlayWaiting>`               |                                                                                         |
+---------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CSoundImp\:\:ReleaseSound<CSoundImpReleaseSound>`             |                                                                                         |
+---------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CSoundImp\:\:ResetVolume<CSoundImpResetVolume>`               |                                                                                         |
+---------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CSoundImp\:\:SetChannel<CSoundImpSetChannel>`                 |                                                                                         |
+---------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CSoundImp\:\:SetCoordinates<CSoundImpSetCoordinates>`         |                                                                                         |
+---------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CSoundImp\:\:SetVolume<CSoundImpSetVolume>`                   |                                                                                         |
+---------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CSoundImp\:\:Stop<CSoundImpStop>`                             |                                                                                         |
+---------------------------------------------------------------------+-----------------------------------------------------------------------------------------+


----

.. _CSoundImpCalcVariableVolume:

CSoundImp\:\:CalcVariableVolume
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CSoundImpCopyData:

CSoundImp\:\:CopyData
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CSoundImpCreate2DBuffer:

CSoundImp\:\:Create2DBuffer
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CSoundImpCreate3DBuffer:

CSoundImp\:\:Create3DBuffer
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CSoundImpCreateBuffer:

CSoundImp\:\:CreateBuffer
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CSoundImpExclusivePlay:

CSoundImp\:\:ExclusivePlay
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CSoundImpExclusiveStop:

CSoundImp\:\:ExclusiveStop
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CSoundImpGetPlayTime:

CSoundImp\:\:GetPlayTime
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CSoundImpIsSoundPlaying:

CSoundImp\:\:IsSoundPlaying
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CSoundImpPlay:

CSoundImp\:\:Play
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

CSoundImp\:\:Play
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CSoundImpPlayWaiting:

CSoundImp\:\:PlayWaiting
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CSoundImpReleaseSound:

CSoundImp\:\:ReleaseSound
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CSoundImpResetVolume:

CSoundImp\:\:ResetVolume
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CSoundImpSetChannel:

CSoundImp\:\:SetChannel
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CSoundImpSetCoordinates:

CSoundImp\:\:SetCoordinates
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CSoundImpSetVolume:

CSoundImp\:\:SetVolume
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CSoundImpStop:

CSoundImp\:\:Stop
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**